Create a Freight Invoice for the Shipment

Create a new Freight Invoice for a Shipment. If no charge_line_items are provided, items are automatically generated from the charge items on the Shipment

SecurityAuthToken
Request
path Parameters
shipmentId
required
string <uuid>

The id of the shipment

Request Body schema: multipart/form-data
required
required
object
documents
Array of any <binary>
object (FreightInvoiceDocumentsMetadata)
Responses
201

Successfully created a Freight Invoice

Response Schema: application/json
object or null

Entity from which payment should be requested

booking_party_tenant_id
string

The id of the booking Party of invoice, also known as customer in Shipwell

Array of objects
created_at
string or null <date-time>
currency
string (Currency) = 3 characters

3-character ISO-4217 currency code

object or null

Custom data. See the custom data guide for more information.

Array of objects

documents uploaded as part of invoice

due_date
string <date>

Date by which the payment is due

external_id
string or null

Reference number for the invoice in external systems

generated_by
string (GeneratedBy)
Enum: "SERVICE_PROVIDER" "BOOKING_PARTY"
id
string or null
invoice_date
string <date>

Date that invoice was created

invoice_number
string

Reference number for the invoice

invoice_source
string
Default: "CARRIER_GENERATED"
object
notes
string

Any notes on the invoice

object
Array of objects
object or null

Entity to which payment should be made

service_provider_id
string

The id of the service provider company in Shipwell. Typically company of entity requesting invoice.

service_provider_name
string

Name of Service Provider at time of Invoice Creation

status
string (Status)
Default: "RECEIVED"

Current status of the invoice

Enum: "RECEIVED" "PASSED" "EXCEPTION" "APPROVED" "SCHEDULED" "PAID" "VOIDED" "REJECTED" "REVIEWING" "PENDING" "DISPUTED" "RESOLVED"
Array of objects
Array of objects (Sub Statuses)

Sub statuses of the invoice

object

Total value of the invoice when it was initially created

object
updated_at
string or null <date-time>
default

Default error response

post/invoicing/shipments/{shipmentId}/freight-invoices/
Request samples 
Response samples 
application/json
{
  • "bill_to": {
    },
  • "booking_party_tenant_id": "string",
  • "charge_line_items": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "currency": "USD",
  • "custom_data": {
    },
  • "documents": [
    ],
  • "due_date": "2019-08-24",
  • "external_id": "string",
  • "generated_by": "SERVICE_PROVIDER",
  • "id": "string",
  • "invoice_date": "2019-08-24",
  • "invoice_number": "string",
  • "invoice_source": "CARRIER_GENERATED",
  • "invoiceable": {
    },
  • "notes": "string",
  • "processed_total": {
    },
  • "product_line_items": [
    ],
  • "remit_to": {
    },
  • "service_provider_id": "string",
  • "service_provider_name": "string",
  • "status": "RECEIVED",
  • "stops": [
    ],
  • "sub_statuses": [
    ],
  • "total_amount": {
    },
  • "total_passed": {
    },
  • "updated_at": "2019-08-24T14:15:22Z"
}
Copyright © Shipwell 2024. All right reserved.